<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Messages</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Messages</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
											<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Flash messages wraping library.</p>
	<ul class="tags">
				<li><span class="field">author:</span> Andrej Jursa</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_libraries---messages.php.html">/libraries/messages.php</a> (line <span class="field"><a href="../__filesource/fsource_LIST_Libraries__librariesmessages.php.html#a8">8</a></span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>


	<a name="sec-const-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constant Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="const-summary">
								<div class="const-title">
					<a href="#FLASH_MESSAGES_NAME" title="details" class="const-name">FLASH_MESSAGES_NAME</a> = 					<span class="var-type"> 'flash_messages'</span>

				</div>
								<div class="const-title">
					<a href="#MESSAGE_TYPE_DEFAULT" title="details" class="const-name">MESSAGE_TYPE_DEFAULT</a> = 					<span class="var-type"> 'default'</span>

				</div>
								<div class="const-title">
					<a href="#MESSAGE_TYPE_ERROR" title="details" class="const-name">MESSAGE_TYPE_ERROR</a> = 					<span class="var-type"> 'error'</span>

				</div>
								<div class="const-title">
					<a href="#MESSAGE_TYPE_SUCCESS" title="details" class="const-name">MESSAGE_TYPE_SUCCESS</a> = 					<span class="var-type"> 'success'</span>

				</div>
							</div>
		</div>
	</div>

	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="var-summary">
																								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$CI" title="details" class="var-name">$CI</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																												
												<div class="method-definition">
											<span class="method-result">Messages</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#add_message" title="details" class="method-name">add_message</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">self::MESSAGE_TYPE_DEFAULT</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#flash_messages_to_smarty" title="details" class="method-name">flash_messages_to_smarty</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#keep_messages" title="details" class="method-name">keep_messages</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">array<mixed></span>
										<a href="#read_messages" title="details" class="method-name">read_messages</a>
										()
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$CI" id="$CI"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$CI</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesmessages.php.html#a13">13</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">var object $CI CodeIgniter.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																			<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
										<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesmessages.php.html#a24">24</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor of library, will automatically inject flash messages to smarty.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Messages</span>
		<span class="method-name">
			__construct
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodadd_message" id="add_message"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">add_message</span> (line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesmessages.php.html#a35">35</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add flash message to array of flash messages.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			add_message
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">self::MESSAGE_TYPE_DEFAULT</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$message</span><span class="var-description">: message text or language constant prepended with lang: prefix.</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$type</span><span class="var-description">: message type, one of MESSAGE_TYPE_* constant from Messages class.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodflash_messages_to_smarty" id="flash_messages_to_smarty"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">flash_messages_to_smarty</span> (line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesmessages.php.html#a70">70</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Inject flash messages to smarty template as $list_flash_messages template variable.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			flash_messages_to_smarty
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodkeep_messages" id="keep_messages"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">keep_messages</span> (line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesmessages.php.html#a46">46</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Force flash messages to be kept to next request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			keep_messages
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodread_messages" id="read_messages"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">read_messages</span> (line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesmessages.php.html#a54">54</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns array of all flash messages currently stored in session.</p>
	<ul class="tags">
				<li><span class="field">return:</span> flash messages.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array<mixed></span>
		<span class="method-name">
			read_messages
		</span>
				()
			</div>
	
		
			
	</div>
						
		</div>
	</div>

	<a name="sec-consts"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
														| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="constFLASH_MESSAGES_NAME" id="FLASH_MESSAGES_NAME"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">FLASH_MESSAGES_NAME</span>
			 = <span class="const-default"> 'flash_messages'</span>
			(line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesmessages.php.html#a19">19</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
</div>
<a name="constMESSAGE_TYPE_DEFAULT" id="MESSAGE_TYPE_DEFAULT"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">MESSAGE_TYPE_DEFAULT</span>
			 = <span class="const-default"> 'default'</span>
			(line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesmessages.php.html#a15">15</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
</div>
<a name="constMESSAGE_TYPE_ERROR" id="MESSAGE_TYPE_ERROR"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">MESSAGE_TYPE_ERROR</span>
			 = <span class="const-default"> 'error'</span>
			(line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesmessages.php.html#a17">17</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
</div>
<a name="constMESSAGE_TYPE_SUCCESS" id="MESSAGE_TYPE_SUCCESS"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">MESSAGE_TYPE_SUCCESS</span>
			 = <span class="const-default"> 'success'</span>
			(line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesmessages.php.html#a16">16</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
</div>
						
		</div>
	</div>

	<p class="notes" id="credit">
		Documentation generated on Fri, 13 Sep 2013 12:32:39 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
	</p>
	</div></body>
</html>